/* Copyright (c) V-Nova International Limited 2025. All rights reserved.
 * This software is licensed under the BSD-3-Clause-Clear License by V-Nova Limited.
 * No patent licenses are granted under this license. For enquiries about patent licenses,
 * please contact legal@v-nova.com.
 * The LCEVCdec software is a stand-alone project and is NOT A CONTRIBUTION to any other project.
 * If the software is incorporated into another project, THE TERMS OF THE BSD-3-CLAUSE-CLEAR LICENSE
 * AND THE ADDITIONAL LICENSING INFORMATION CONTAINED IN THIS FILE MUST BE MAINTAINED, AND THE
 * SOFTWARE DOES NOT AND MUST NOT ADOPT THE LICENSE OF THE INCORPORATING PROJECT. However, the
 * software may be incorporated into a project under a compatible license provided the requirements
 * of the BSD-3-Clause-Clear license are respected, and V-Nova Limited remains
 * licensor of the software ONLY UNDER the BSD-3-Clause-Clear license (not the compatible license).
 * ANY ONWARD DISTRIBUTION, WHETHER STAND-ALONE OR AS PART OF ANY OTHER PROJECT, REMAINS SUBJECT TO
 * THE EXCLUSION OF PATENT LICENSES PROVISION OF THE BSD-3-CLAUSE-CLEAR LICENSE. */

#ifndef VN_LCEVC_API_TRICKPLAY_H
#define VN_LCEVC_API_TRICKPLAY_H

#include <cstdint>
#include <string_view>
#include <vector>

enum TrickplayAction
{
    Peek,
    Skip,
    Synchronize,
    Flush,
};

struct Trickplay
{
    TrickplayAction action; /**< The API to call */
    uint64_t frameNum;      /**< The output frame number to call that API on */
    uint64_t timestamp;     /**< Optional timestamp argument for skip and peek APIs */
    bool dropPending;       /**< Optional dropPending argument synchronize API */
    bool completed; /**< Marked true when the event has been triggered to ensure it only fires once */
};

std::vector<Trickplay> parseTrickplayJson(std::string_view jsonStr);

void logTrickplay(Trickplay* trickplay);

#endif // VN_LCEVC_API_TRICKPLAY_H
